Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Human-readable template component docs #705

Merged
merged 5 commits into from
Dec 6, 2024
Merged

Conversation

dkfellows
Copy link
Collaborator

Add extra parameter to give human-readable docs for template components. Yes, the repr of Python objects is technically human readable, but I doubt that most humans want that; I certainly don't!

Fixes #704

@dkfellows dkfellows requested a review from aplowman as a code owner December 3, 2024 14:40
@dkfellows dkfellows linked an issue Dec 3, 2024 that may be closed by this pull request
@dkfellows dkfellows added the documentation Improvements or additions to documentation label Dec 3, 2024
@dkfellows dkfellows self-assigned this Dec 3, 2024
@dkfellows
Copy link
Collaborator Author

The breakage on CentOS is entirely unrelated to this PR.

@dkfellows
Copy link
Collaborator Author

Examples of how we now render things:

lammps_dump_files

A regular expression pattern that matches all the dump files generated by a LAMMPS run.

null_env

The default system environment.

dummy_task_1

Description

A dummy task showing simple output file parsing. (p1, p2, p5) → p3

Copy link
Contributor

@aplowman aplowman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@dkfellows dkfellows merged commit c6e745a into develop Dec 6, 2024
47 of 49 checks passed
@dkfellows dkfellows deleted the doc-template-components branch December 6, 2024 12:13
dkfellows added a commit to dkfellows/matflow-new that referenced this pull request Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

More docs in template components
3 participants